Operation Blob.SetMetadataFromDocument (Write Metadata To Binary From Document)

Description

Write metadata to a Blob (xpath parameter, or BlobHolder if empty) from a document (input) given a custom metadata mapping defined in a Properties parameter, using a named processor (exifTool for instance).

Operation id	Blob.SetMetadataFromDocument
Aliases	`Binary.WriteMetadataFromDocument`
Category	Files
Label	Write Metadata To Binary From Document
Requires
Since	7.1

Parameters

Name	Description	Type	Required	Default value
metadata	Metadata to write into the input document blob.	properties	yes
blobXPath	The blob xpath on the document. Default blob property for empty parameter.	string	no
ignorePrefix	Ignore metadata prefixes or not	boolean	no
processor	The processor to execute for overriding the input document blob.	string	no
save		boolean	no	true

Signature

Inputs	document
Outputs	document

Implementation Information

Implementation Class	Class: org.nuxeo.binary.metadata.internals.operations.WriteMetadataToBinaryFromDocument
Contributing Component	org.nuxeo.binary.metadata

JSON Definition

{
  "id" : "Blob.SetMetadataFromDocument",
  "aliases" : [ "Binary.WriteMetadataFromDocument" ],
  "label" : "Write Metadata To Binary From Document",
  "category" : "Files",
  "requires" : null,
  "description" : "Write metadata to a Blob (xpath parameter, or BlobHolder if empty) from a document (input) given a custom metadata mapping defined in a Properties parameter, using a named processor (exifTool for instance).",
  "since" : "7.1",
  "url" : "Blob.SetMetadataFromDocument",
  "signature" : [ "document", "document" ],
  "params" : [ {
    "name" : "metadata",
    "description" : "Metadata to write into the input document blob.",
    "type" : "properties",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "blobXPath",
    "description" : "The blob xpath on the document. Default blob property for empty parameter.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "ignorePrefix",
    "description" : "Ignore metadata prefixes or not",
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "processor",
    "description" : "The processor to execute for overriding the input document blob.",
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "save",
    "description" : null,
    "type" : "boolean",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ "true" ]
  } ]
}